home *** CD-ROM | disk | FTP | other *** search
/ Amiga Plus Special 23 / AMIGAplus Sonderheft 23 (2000)(Falke)(DE)[!].iso / c / MPGui.doc < prev    next >
Text File  |  2000-01-01  |  19KB  |  643 lines
  1.  
  2.  
  3. TABLE OF CONTENTS
  4.  
  5. MPGui.library/--background--
  6. MPGui.library/--RunMPGui--
  7. MPGui.library/AllocMPGuiHandleA
  8. MPGui.library/FreeMPGuiHandle
  9. MPGui.library/MPGuiCurrentAttrs
  10. MPGui.library/MPGuiError
  11. MPGui.library/MPGuiResponse
  12. MPGui.library/MPGuiWindow
  13. MPGui.library/ReadMPGui
  14. MPGui.library/RefreshMPGui
  15. MPGui.library/SetMPGuiGadgetValue
  16. MPGui.library/SyncMPGuiRequest
  17. MPGui.library/WriteMPGui
  18.  
  19.  
  20. MPGui.library/--background--                      MPGui.library/--background--
  21.  
  22.  MPGui provides an easy way to display simple single colum requesters with
  23.  File/String/Number/Slider/Cycle/Check/ScreenMode/List gadgets.
  24.  
  25.  It uses a text input file to specify the format of the Gui.
  26.  
  27.  Menus can be provided.
  28.  
  29.  Bottom gadgets can be "Ok/Cancel" for normal gadgets or "Save/Use/Cancel"
  30.  for preferences requesters.
  31.  From Version 5.2 the short cuts for these buttons will automatically be
  32.  disabled if required. The library is also localised.
  33.  
  34.  From Version 5.4 opens locale.library(38) to work on OS3.0.
  35.  
  36.  Normal Help and continuous Help is supported.
  37.  
  38.  Keyboard shortcuts are supported.
  39.  
  40.  The format of the file is:
  41.  
  42.  * comment
  43.                   Comment line
  44.  
  45.  Any #n# (n>=0) will be replaced by parameters if supplied
  46.  ## is changed to # if parameters are supplied
  47.  
  48.  Some standard C conversions are done with \ values
  49.   \\ -> \
  50.   \" -> "
  51.   \t -> tab
  52.   \n -> newline
  53.  
  54.  "command "HelpMessage
  55.         etc.      Command (etc. is ignored)
  56.   "Comment"       Comment for heading of requester
  57.   "HelpNode"      Global Help Node for requester
  58.   GADGET "Title":"prefix"!HelpNode!HelpMessage!
  59.                          A Gadget
  60.                          GAGDET is type of gadget (see below).
  61.                          "Title" is gadget title
  62.                          "prefix" appears before the value in the result
  63.                                   if prefix includes %s then result
  64.                                   replaces %s instead
  65.                          !HelpNode! is optional help string to
  66.                                     use in call back
  67.                          !HelpMessage is displayed in text gadget at top
  68.  
  69.   LFILE "Title":"prefix":"def"!Help!
  70.                   Input file string and request gadget
  71.                   Key activates
  72.                   Right shift and key shows requester
  73.   SFILE "Title":"prefix":"def"!Help!
  74.                   Output file string and gadget
  75.                   Key activates
  76.                   Right shift and key shows requester
  77.   FILE "T":"P":"def"!Help!
  78.                   File string and request (input file)
  79.                   Key activates
  80.                   Right shift and key shows requester
  81.   OFILE "T":"P":"def":Y/N!Help!
  82.                   Optional file (has checkbox)
  83.                   Key toggles and activates if becomes selectable
  84.                   Left shift and key activates if selectable
  85.                   Right shift and key shows requester if selectable
  86.   ONUMBER "T":"P":"def":Y/N!Help!
  87.                   Optional number (has checkbox)
  88.                   Key toggles and activates if becomes selectable
  89.                   Left shift and key activates if selectable
  90.   NUMBER "T":"P":"def"!Help!
  91.                   Number
  92.                   Key activates
  93.   CYCLE "Title"!Help!
  94.                   Cycle gadget, each entry can be followed by other gadgets
  95.                   Key cycles
  96.                   Shift and key cycles back
  97.         "value1":"Prefix1"
  98.         "value2":"Prefix2"
  99.      gadgets      
  100.                   Only active when item is 2
  101.         "value3":"Prefix3"
  102.   ENDCYCLE:"number or valuen" 
  103.                   Finished by default value (numeric or string)
  104.   STRING "Title":"prefix":"def"!Help!
  105.                   String - use for floating point as well
  106.                   Key activates
  107.   OSTRING "Title":"prefix":"def":Y/N!Hlp!
  108.                   String with checkbox
  109.                   Key toggles and activates if becomes selectable
  110.                   Left shift and key activates if selectable
  111.   CHECK "T":"P":"NPrefix":Y/N!Help
  112.                   Check box gadget
  113.                   NPrefix (optional) used if Check not selected
  114.                   Key toggles
  115.   SLIDER "T":"P":"min":"max":"def"!Hlp!
  116.                   Slider gadget
  117.                   Key increases
  118.                   Shift and key decreases
  119.   MODEn "T":"P":"def"!Help!
  120.                   Screen Mode requester
  121.                   Key shows requester
  122.                   n == 1 -> Workbench modes
  123.                        2 -> Workbench modes + NONE
  124.                        3 -> All modes
  125.                        4 -> All modes + NONE (3 and 4 do not work too well)
  126.   OMODEn "T":"P":"def":Y/N!Help!
  127.                   Optional Screen Mode requester
  128.                   Key toggles
  129.                   Right shift and key shows requester if selectable
  130.   FONTn "T":"P":"def"!Help!
  131.                   Font requester
  132.                   Key shows requester
  133.                   n == 1 -> All Fonts
  134.                        2 -> Fixed width only
  135.   OFONTn "T":"P":"def":Y/N!Help!
  136.                   Optional Font requester
  137.                   Key toggles
  138.                   Right shift and key shows requester if selectable
  139.   LIST "Title":!Help!
  140.                   List view
  141.                   Key cycles
  142.                   Shift and key cycles back
  143.        "value1":"prefix1"
  144.        "value2":"prefix2"
  145.   ENDLIST:"number or valuen":"lines"
  146.                   finished by default value and lines (optional) default 4
  147.   MLIST "Title":!Help!
  148.                   List view
  149.                   Key cycles
  150.                   Left shift and key cycles back
  151.                   Right shift and key toggles selected
  152.        "value1":"prefix1":"NPrefix1" (Negative Prefix optional)
  153.        "value2":"prefix2"
  154.   ENDMLIST:"values":"lines"
  155.                   finished by default selected values (space seperated)
  156.                   and lines (optional) default 4
  157.   BUTTON "Title"  List of button gadgets - horizontal
  158.                   If Title zero length then full width is used
  159.        "Button text1":"n"!Help!HelpMessage!  n is number of button
  160.        "Button text2":"m"!Help!HelpMessage!
  161.   ENDBUTTON
  162.   TEXT "Title":"def"Y/N!Help!HelpMessage!    (added in 5.1)
  163.                   Text - If title 0 length then full width
  164.                   Y to Center Text
  165.   MTEXT "def"Y/N!Help!HelpMessage!    (added in 5.1)
  166.                   Text without border
  167.                   Y to Center Text
  168.  
  169. MPGui.library/--RunMPGui--                          MPGui.library/--RunMPGui--
  170.  
  171.  RunMPGui provides a simple Shell interface to MPGui.library
  172.  
  173.  Parameters are:
  174.  
  175.  FROM/A       Input GUI file
  176.  TO/K         Output file
  177.  RELMOUSE/S   Open reqester by the pointer
  178.  PUBSCREEN/K  Specify the public screen to open on
  179.  HELP/K       AmigaGuide file to show help
  180.  CHELP/S      Show help continuously
  181.  NEWLINE/S    Put a new line between each gadget
  182.  PREFS/S      Show Save/Use/Cancel gadgets rather than OK/Cancel
  183.  BUTTONS/K    Command to run when a button is pressed
  184.  NOBUTTONS/S  Do not show OK/Cancel gadgets
  185.  PARAMS/K/M   Parameters to substitute in GUI file
  186.  
  187.  The BUTTON command should be specified as "command %ld %ld"
  188.  
  189.  The command is then passed two numbers - the address of the handle and
  190.  the number of the button.
  191.  
  192.  Return a failure from this command to Cancel the GUI.
  193.  
  194.  The response from MPGui is:
  195.  
  196.    0 if OK is pressed;
  197.    5 if Cancel is pressed;
  198.   10 if there is an error in the GUI file;
  199.   20 if there is some fatal error.
  200.  
  201.  Version 5 - Refreshes windows when a requester is open
  202.              Tries amigaguide.library version 34
  203.  Version 5.2 - Localised.
  204.  Version 5.3 - non beta
  205.  Version 5.4 - Opens locale.library(38) to work on OS3.0.
  206.  
  207. MPGui.library/AllocMPGuiHandleA                MPGui.library/AllocMPGuiHandleA
  208.  
  209.    NAME   
  210.   AllocMPGuiHandleA -- Allocates an MPGuiHandle. (V3)
  211.   AllocMPGuiHandle -- Varargs version of AllocMPGuiHandleA (V3)
  212.  
  213.    SYNOPSIS
  214.   gh = AllocMPGuiHandleA(taglist)
  215.   D0                     A0
  216.  
  217.   struct MPGuiHandle * AllocMPGuiHandleA(struct TagItem *);
  218.  
  219.   gh = AllocMPGuiHandle(Tag1, ...)
  220.  
  221.   struct MPGuiHandle * AllocMPGuiHandle(ULONG,...);
  222.  
  223.    FUNCTION
  224.   Allocates an MPGuiHandle.
  225.  
  226.    INPUTS
  227.   taglist - pointer to TagItem array.
  228.  
  229.   Tags are:
  230.  
  231.   MPG_PUBSCREENNAME - Data is char * name of public screen to use.
  232.